Create Consentless Lead

The Create Consentless Lead request enables you to create a Consentless lead. A Service Provider or Channel partner can create a Consentless lead (see Create Consentless Lead in Multitenant Portal that is sent directly to the Operator Connect portal. As a result, the customer does not need to provide consent to partner their preferred operator in their Teams admin center. In addition, the 'Size' and 'Market' parameters are not populated for the lead generation.

URI

Copy

{{baseUrl}}/api/v2/oc/lead

HTTP Method

POST

Request Headers

You can alternatively specify either of the following headers, both of which return identical output.

Attribute	Type	Description
X-Ovoc-Channel-Id	integer	The Live Platform channel id. When specified, data is scoped to only customers belonging to the specified channel. See Get List of Channels to extract this value.
X-IAM-Account-Id	string	The Live Platform iamAccountId of the channel. When specified, data is scoped to only customers belonging to the specified channel. See Get List of Channels to extract this value.

Request Body

Parameter	Mandatory	Type	Description
tenantId	Ö	string	Microsoft Azure tenant subscription Id of the customer lead.
companyName	Ö	string	The customer tenant company name.
channelId	´	string	The Id of the Channel reseller to attach to the lead (see Get List of Channels). You can also later assign a channel to a lead using Assign Consentless Lead to Channel.

Example Request

Copy

{
  "tenantId": "41747617-089b-4128-a9c8-7c9c2c596c25",
  "companyName": "SIPTest2"
 }

HTTP Responses

■

200 OK

Copy

■

400 Bad Request: The following shows an example of a lead that is not valid due to an incorrect Tenant Id.

Copy

{
    "errors": {
        "tenantId": [
            "After parsing a value an unexpected character was encountered: \". Path 'tenantId', line 3, position 2."
        ]
    },
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-f05f803cbed1e5a202773c1dc235187f-a95568b2a37844c9-00"
}

The following error is displayed if the lead already exists.

Copy

{
    "errors": {
        "TenantId": [
            "This MsTenant already exists as an UMP lead!"
        ],
        "CompanyName": [
            "Company name is already used for an UMP lead."
        ]
    },
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-54ea6541df8ae6471f687fbcda12cabb-5fbf4d4c35799b30-00"
}

■

403 Forbidden: This error is raised when the channelId specified in the Request Body is not associated with the channel specified in the Request Header.

Parameter	Type	Description/Examples
errors	string	Text description of the error.
type	string	"https://tools.ietf.org/html/rfc7231#section-6.5.1"
title	string	Email title. For example "One or more validation errors occurred."
status	error code	HTML error code i.e. 400
detail	string	Additional error details.
traceId	string	Error trace Id
instance	string	Error instance
errorTicket	string	This field may not appear for all return codes.
errorCode	string	This field may not appear for all return codes.
additionalProp1	string	Custom Script variable argument. For example "CacProfile": "5 sessions"
additionalProp2	string	Custom Script argument. For example, ProxySet": "SIPTrunk"
additionalProp3	string	Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"

■

500 Internal Server Error